Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.18.1 StructureDefinition: QICore-Immunization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/qicore-immunization

Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

F.18.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S0..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(QICore-Patient)Who was immunized
... wasNotGiven ?! S1..1booleanFlag for whether immunization was given
... reported 1..1booleanIndicates a self-reported record
... performer 0..1Reference(QICore-Practitioner)Who administered vaccine
... requester 0..1Reference(QICore-Practitioner)Who ordered vaccination
... encounter S0..1Reference(QICore-Encounter)Encounter administered as part of
... manufacturer 0..1Reference(QICore-Organization)Vaccine manufacturer
... location 0..1Reference(QICore-Location)Where vaccination occurred
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(QICore-Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol 0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(QICore-Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

todo

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S0..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine product administered
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(QICore-Patient)Who was immunized
... wasNotGiven ?! S1..1booleanFlag for whether immunization was given
... reported 1..1booleanIndicates a self-reported record
... performer 0..1Reference(QICore-Practitioner)Who administered vaccine
... requester 0..1Reference(QICore-Practitioner)Who ordered vaccination
... encounter S0..1Reference(QICore-Encounter)Encounter administered as part of
... manufacturer 0..1Reference(QICore-Organization)Vaccine manufacturer
... location 0..1Reference(QICore-Location)Where vaccination occurred
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation 0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(QICore-Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol 0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(QICore-Organization)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

F.18.1.2 Terminology Bindings

PathNameConformanceValueSet
Immunization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Immunization.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
Immunization.vaccineCodeVaccine Administered Value SetpreferredVaccine Administered Value Set
Immunization.siteVaccine Administered Body SitepreferredVaccine Administered Body Site
Immunization.routeImmunization Route CodesexampleImmunization Route Codes
Immunization.explanation.reasonImmunization Reason CodesexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenImmunization Reasons for Not Immunizing CodesexampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.targetDiseaseVaccination Protocol Dose Target CodesexampleVaccination Protocol Dose Target Codes
Immunization.vaccinationProtocol.doseStatusVaccination Protocol Dose Status codesexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonVaccination Protocol Dose Status Reason codesexampleVaccination Protocol Dose Status Reason codes

F.18.1.3 Constraints

IdPathDetailsRequirements
imm-2ImmunizationIf immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
XPath: not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))
imm-1ImmunizationIf immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
XPath: not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))
.